<?php

/**
 * This code was generated by
 * \ / _    _  _|   _  _
 * | (_)\/(_)(_|\/| |(/_  v1.0.0
 * /       /
 */

namespace Twilio\Rest\Wireless\V1;

use Twilio\Options;
use Twilio\Values;

abstract class CommandOptions {
	/**
	 * @param string $sim Only return Commands to or from this SIM.
	 * @param string $status Only return Commands with this status value.
	 * @param string $direction Only return Commands with this direction value.
	 * @param string $transport Only return Commands with this transport value.
	 *
	 * @return ReadCommandOptions Options builder
	 */
	public static function read( $sim = Values::NONE, $status = Values::NONE, $direction = Values::NONE, $transport = Values::NONE ) {
		return new ReadCommandOptions( $sim, $status, $direction, $transport );
	}

	/**
	 * @param string $sim The Sid or UniqueName of the SIM to send the Command to.
	 * @param string $callbackMethod The HTTP method Twilio will use when making a
	 *                               request to the callback URL.
	 * @param string $callbackUrl Twilio will make a request to this URL when the
	 *                            Command has finished sending.
	 * @param string $commandMode A string representing which mode to send the SMS
	 *                            message using.
	 * @param string $includeSid When sending a Command to a SIM in text mode,
	 *                           Twilio can automatically include the Sid of the
	 *                           Command in the message body, which could be used
	 *                           to ensure that the device does not process the
	 *                           same Command more than once.
	 * @param boolean $deliveryReceiptRequested A boolean representing whether to
	 *                                          request delivery receipt from the
	 *                                          recipient.
	 *
	 * @return CreateCommandOptions Options builder
	 */
	public static function create( $sim = Values::NONE, $callbackMethod = Values::NONE, $callbackUrl = Values::NONE, $commandMode = Values::NONE, $includeSid = Values::NONE, $deliveryReceiptRequested = Values::NONE ) {
		return new CreateCommandOptions( $sim, $callbackMethod, $callbackUrl, $commandMode, $includeSid, $deliveryReceiptRequested );
	}
}

class ReadCommandOptions extends Options {
	/**
	 * @param string $sim Only return Commands to or from this SIM.
	 * @param string $status Only return Commands with this status value.
	 * @param string $direction Only return Commands with this direction value.
	 * @param string $transport Only return Commands with this transport value.
	 */
	public function __construct( $sim = Values::NONE, $status = Values::NONE, $direction = Values::NONE, $transport = Values::NONE ) {
		$this->options['sim']       = $sim;
		$this->options['status']    = $status;
		$this->options['direction'] = $direction;
		$this->options['transport'] = $transport;
	}

	/**
	 * Only return Commands to or from this SIM.
	 *
	 * @param string $sim Only return Commands to or from this SIM.
	 *
	 * @return $this Fluent Builder
	 */
	public function setSim( $sim ) {
		$this->options['sim'] = $sim;

		return $this;
	}

	/**
	 * Only return Commands with this status value.
	 *
	 * @param string $status Only return Commands with this status value.
	 *
	 * @return $this Fluent Builder
	 */
	public function setStatus( $status ) {
		$this->options['status'] = $status;

		return $this;
	}

	/**
	 * Only return Commands with this direction value.
	 *
	 * @param string $direction Only return Commands with this direction value.
	 *
	 * @return $this Fluent Builder
	 */
	public function setDirection( $direction ) {
		$this->options['direction'] = $direction;

		return $this;
	}

	/**
	 * Only return Commands with this transport value.
	 *
	 * @param string $transport Only return Commands with this transport value.
	 *
	 * @return $this Fluent Builder
	 */
	public function setTransport( $transport ) {
		$this->options['transport'] = $transport;

		return $this;
	}

	/**
	 * Provide a friendly representation
	 *
	 * @return string Machine friendly representation
	 */
	public function __toString() {
		$options = array();
		foreach ( $this->options as $key => $value ) {
			if ( $value != Values::NONE ) {
				$options[] = "$key=$value";
			}
		}

		return '[Twilio.Wireless.V1.ReadCommandOptions ' . implode( ' ', $options ) . ']';
	}
}

class CreateCommandOptions extends Options {
	/**
	 * @param string $sim The Sid or UniqueName of the SIM to send the Command to.
	 * @param string $callbackMethod The HTTP method Twilio will use when making a
	 *                               request to the callback URL.
	 * @param string $callbackUrl Twilio will make a request to this URL when the
	 *                            Command has finished sending.
	 * @param string $commandMode A string representing which mode to send the SMS
	 *                            message using.
	 * @param string $includeSid When sending a Command to a SIM in text mode,
	 *                           Twilio can automatically include the Sid of the
	 *                           Command in the message body, which could be used
	 *                           to ensure that the device does not process the
	 *                           same Command more than once.
	 * @param boolean $deliveryReceiptRequested A boolean representing whether to
	 *                                          request delivery receipt from the
	 *                                          recipient.
	 */
	public function __construct( $sim = Values::NONE, $callbackMethod = Values::NONE, $callbackUrl = Values::NONE, $commandMode = Values::NONE, $includeSid = Values::NONE, $deliveryReceiptRequested = Values::NONE ) {
		$this->options['sim']                      = $sim;
		$this->options['callbackMethod']           = $callbackMethod;
		$this->options['callbackUrl']              = $callbackUrl;
		$this->options['commandMode']              = $commandMode;
		$this->options['includeSid']               = $includeSid;
		$this->options['deliveryReceiptRequested'] = $deliveryReceiptRequested;
	}

	/**
	 * The Sid or UniqueName of the [SIM](https://www.twilio.com/docs/api/wireless/rest-api/sim) to send the Command to.
	 *
	 * @param string $sim The Sid or UniqueName of the SIM to send the Command to.
	 *
	 * @return $this Fluent Builder
	 */
	public function setSim( $sim ) {
		$this->options['sim'] = $sim;

		return $this;
	}

	/**
	 * The HTTP method Twilio will use when making a request to the callback URL (valid options are GET or POST). Defaults to POST.
	 *
	 * @param string $callbackMethod The HTTP method Twilio will use when making a
	 *                               request to the callback URL.
	 *
	 * @return $this Fluent Builder
	 */
	public function setCallbackMethod( $callbackMethod ) {
		$this->options['callbackMethod'] = $callbackMethod;

		return $this;
	}

	/**
	 * Twilio will make a request to this URL when the Command has finished sending (delivered or failed).
	 *
	 * @param string $callbackUrl Twilio will make a request to this URL when the
	 *                            Command has finished sending.
	 *
	 * @return $this Fluent Builder
	 */
	public function setCallbackUrl( $callbackUrl ) {
		$this->options['callbackUrl'] = $callbackUrl;

		return $this;
	}

	/**
	 * A string representing which mode to send the SMS message using. May be `text` or `binary`. If omitted, the default SMS mode is `text`.
	 *
	 * @param string $commandMode A string representing which mode to send the SMS
	 *                            message using.
	 *
	 * @return $this Fluent Builder
	 */
	public function setCommandMode( $commandMode ) {
		$this->options['commandMode'] = $commandMode;

		return $this;
	}

	/**
	 * When sending a Command to a SIM in text mode, Twilio can automatically include the Sid of the Command in the message body, which could be used to ensure that the device does not process the same Command more than once. The options for inclusion are `none`, `start` and `end`. The default behavior is `none`. When using `start` or `end`, the CommandSid will be prepended or appended to the message body, with a space character separating the CommandSid and the message body. The length of the CommandSid contributes toward the 160 character limit, i.e. the SMS body must be 128 characters or less before the Command Sid is included.
	 *
	 * @param string $includeSid When sending a Command to a SIM in text mode,
	 *                           Twilio can automatically include the Sid of the
	 *                           Command in the message body, which could be used
	 *                           to ensure that the device does not process the
	 *                           same Command more than once.
	 *
	 * @return $this Fluent Builder
	 */
	public function setIncludeSid( $includeSid ) {
		$this->options['includeSid'] = $includeSid;

		return $this;
	}

	/**
	 * A boolean representing whether to request delivery receipt from the recipient. For Commands that request delivery receipt, the Command state transitions to 'delivered' once the server has received a delivery receipt from the device. Defaults to true.
	 *
	 * @param boolean $deliveryReceiptRequested A boolean representing whether to
	 *                                          request delivery receipt from the
	 *                                          recipient.
	 *
	 * @return $this Fluent Builder
	 */
	public function setDeliveryReceiptRequested( $deliveryReceiptRequested ) {
		$this->options['deliveryReceiptRequested'] = $deliveryReceiptRequested;

		return $this;
	}

	/**
	 * Provide a friendly representation
	 *
	 * @return string Machine friendly representation
	 */
	public function __toString() {
		$options = array();
		foreach ( $this->options as $key => $value ) {
			if ( $value != Values::NONE ) {
				$options[] = "$key=$value";
			}
		}

		return '[Twilio.Wireless.V1.CreateCommandOptions ' . implode( ' ', $options ) . ']';
	}
}